home *** CD-ROM | disk | FTP | other *** search
/ TPUG - Toronto PET Users Group / TPUG Users Group CD / TPUG Users Group CD.iso / AMIGA / (A)Z / (A)Z10.ADF / A_Host / ahost.doc < prev    next >
Text File  |  1989-07-04  |  12KB  |  372 lines
  1.  
  2.  
  3.  
  4.                       -= AmigaHost =-
  5.                   Amiga Terminal Emulator
  6.  
  7.                  Version 0.9, 1-August-1986
  8.  
  9.              Copyright (C) 1986 CompuServe Inc.
  10.               By Steve Wilhite & George Jones
  11.  
  12.  
  13.  
  14.  
  15. 1.0  INTRODUCTION
  16.  
  17. AmigaHost (AHost) is a  full  featured,  terminal  emulation
  18. program for the Amiga.
  19.  
  20. AmigaHost features ANSI terminal  emulation,  file  transfer
  21. with  CompuServe's  B-Protocol,  KERMIT,  and  XMODEM,  file
  22. capture/send, user  defineable  function  keys,  a  "script"
  23. language,  RLE  graphics,  and a special Conference Mode for
  24. use with CIS.
  25.  
  26. AmigaHost was designed primaraly for use  with  CompuServe's
  27. Consumer  Information  Service  (CIS).   However, it is well
  28. suited for use in many diverse environments.
  29.  
  30. AmigaHost may be freely copied and distributed.  It may  not
  31. be sold or used for profit.
  32.  
  33.  
  34.  
  35. 2.0  TERMINAL EMULATION
  36.  
  37. AmigaHost recognizes ANSI escape  sequences  by  useing  the
  38. Amiga's  console  device.   For best Effect with CIS, select
  39. terminal type VT100 (type GO TERMINAL at any "!" prompt).
  40.  
  41. The baud rate is  automaticly  set  to  the  rate  that  was
  42. selected via preferences.
  43.  
  44.  
  45.  
  46. 3.0  RUNNING AMIGAHOST
  47.  
  48. AmigaHost may be run from workbench or  CLI.   To  run  from
  49. workbench,   double   click  the  AmigaHost  icon.   To  run
  50. AmigaHost from  CLI  connect  to  the  directory  (CD)  that
  51. contains AmigaHost and type "ahost".  If AmigaHost is copied
  52. to c:  typing "ahost" will always run the program.
  53.                                                       Page 2
  54.  
  55.  
  56. 4.0  FUNCTION KEYS
  57.  
  58. Each function key may be have up to four definitions  stored
  59. for  it, so that when you hit the key the text is sent to to
  60. the  host  computer  (the  key  definitions   are   actually
  61. scripts).
  62.  
  63. To define a function key, select "Define Function Key"  from
  64. the  options  menu,  then  select  select "Normal", "Shift",
  65. "Control" or "Alt" (=  Amiga  Key)  from  the  sub-menu.   A
  66. requester will pop up and allow you to enter definitions for
  67. each of the ten function keys.  Enter your  definitions  and
  68. then select "OK".
  69.  
  70. To execute a function key, simply hit it  (or  with  "Ctrl",
  71. "Alt" or "Shift" as appropriate.
  72.  
  73. When AmigaHost is exited, the key definitions are saved into
  74. a file called "Softkeys.def".  When AmigaHost starts up this
  75. file is read in to set up the initial definitions.
  76.  
  77.  
  78.  
  79. 5.0  SCRIPTS
  80.  
  81. "Scripting"  allows  you  to   perform   automatic   logins,
  82. automaticly capture messages, and perform simple commands.
  83.  
  84. Here is a sample script that will log in to  CompuServe  and
  85. capture all the new messages from the AmigaForum and logout.
  86. #!++
  87. #! Abstract:
  88. #!      Example script file for the AmigaHost terminal program.
  89. #!
  90. #!      The dial command for Hayes smartmodem.
  91. #!
  92. #! Authors: Steve Wilhite
  93. #!
  94. #! Revision History:
  95. #!
  96. #!--
  97. #
  98. ATD 457-6133
  99. #!  ^^^^^^^^------------- your local CIS node phone number goes here
  100. #!
  101. #! Wait for the message from the modem, indicating carrier.
  102. #!
  103. #p'CONNECT'w'2'
  104. #
  105. #p'Host Name:'cis
  106. #p'User ID:'XXXXX,XXXX
  107. #!          ^^^^^^^^^^----- your ppn goes here
  108. #!          vvvvvvvvvvvv--- your password goes here
  109. #p'Password'XXXXXXXXXXXX
  110. #!
  111.                                                       Page 3
  112.  
  113.  
  114. #! Start log file.  This will append to the file if one already exists.
  115. #! Visit our sig and read new messages.
  116. #!
  117. #lo'sig.msg'#
  118. #p'TOP'go pcs61
  119. #p'Function:'rn
  120. #(
  121.         'Function:',    'logoff',
  122.         '(UA RE T):',   'set-nonstop'
  123. )#
  124. #:'set-nonstop'#
  125. ns
  126. #p'Function:'#
  127. #!
  128. #! That's all folks
  129. #!
  130. #:'logout'off
  131. #p'Name:'off
  132. #!
  133. #! Close the log file and exit AHost
  134. #!
  135. #lc#
  136. #e
  137.  
  138. AmigaHost  scripts  are  implemented  with  a  very  simple,
  139. interpreted  language.  A script consists of text to be sent
  140. to the host computer, mixed with  script  commands.   Script
  141. commands  start  with  a  pound  sign character, #, which is
  142. followed by one or  two  characters  denoting  the  specific
  143. command.   Some  commands  take  one or more arguments.  The
  144. arguments are quoted strings (separated by commas  if  there
  145. is  more  than one argument).  Any character may be used for
  146. the quoting.  The second occurrence of the  quote  character
  147. terminates the argument.
  148.  
  149. Scripts may be stored in files or function key.  To  execute
  150. a  script from a file, select "Execute script file" from the
  151. "Options" menu.  To execute a script from  a  function  key,
  152. simply define it and press it.
  153.  
  154.  
  155.  
  156. 5.1  Script Commands
  157.  
  158. The following is a list of the script commands supported  by
  159. AmigaHost:
  160.  
  161.  
  162. #<new-line>              "#" at the end of line is  ignored.
  163.                          This  allows  script  files  to  be
  164.                          formatted in an  visually  pleasing
  165.                          manner.
  166.  
  167. #!                       This is introduces a comment.   All
  168.                          characters on a line following "#!"
  169.                                                       Page 4
  170.  
  171.  
  172.                          are ignored.
  173.  
  174. #:'label-name'           This introduces  a  label.   Labels
  175.                          provide  reference  points  in  the
  176.                          script to  tell  the  "go  to"  and
  177.                          "case"   commands   where   to   go
  178.                          (implementors comment:  I felt like
  179.                          telling    the   case   and   go-to
  180.                          statements where to go !).
  181.  
  182.                          Labels are case sensitive.
  183.  
  184. #('pattern', 'label' [, 'pattern', 'label']...[,'seconds'])
  185.                          This is a case statement.  The case
  186.                          statement  is begins with "#(", and
  187.                          is followed by any number of quoted
  188.                          pattern/label pairs, and optionally
  189.                          a integer " timeout" value.
  190.  
  191.                          If the any of the the patterns  are
  192.                          sent  by  the  host  computer,  the
  193.                          script jumps to  the  corresponding
  194.                          label  and execution resumes there.
  195.                          If timeout value is specified,  and
  196.                          none   of  the  patterns  are  seen
  197.                          within the given number of seconds,
  198.                          execution   resumes  following  the
  199.                          case statement.
  200.  
  201.                          Patterns are case sensitive.  An an
  202.                          attempt to go to an undefined label
  203.                          will terminate the script.
  204.  
  205. #command                 The  text  of   the   argument   is
  206.                          executed  as  an  AmigaDOS command.
  207.                          Wait for the command to finish.
  208.  
  209. #e                       Exits AmigaHost
  210.  
  211. #g'label'                Go to the the specified label.
  212.  
  213. #i+                      "#i+" makes output  from  the  host
  214.                          computer invisible.
  215.  
  216. #i-                      "#i-" makes output  from  the  host
  217.                          computer                    visible
  218.                          (un-invisible).SKIP
  219. #lo'file'                Open  a  logfile  and   write   all
  220.                          incomming  characters to the screen
  221.                          and the file.
  222.  
  223.                          If the file exists text is appended
  224.                          to the end of the file.
  225.  
  226. #lc                      Close the logfile.
  227.                                                       Page 5
  228.  
  229.  
  230. #p'pattern'              Wait   unconitionally    for    the
  231.                          specified  pattern  from  the  host
  232.                          (dangerous).
  233.  
  234. #s'file'                 Execute the  specified  file  as  a
  235.                          sub-script file.
  236.  
  237. #t'text'                 Type  the  specified  text  to  the
  238.                          screen.
  239.  
  240.                          "\c" is translated  to  Control-"c"
  241.                          where   "c"   is   any   alphabetic
  242.                          character.  "\\" is  translated  to
  243.                          "\".
  244.  
  245. #w'number'               Wait for specified number of second
  246.  
  247. #xp;                     Start a new  CLI  (Push  to  a  new
  248.                          shell).     The   script   proceeds
  249.                          without  waiting  for  the  CLI  to
  250.                          finish.
  251.  
  252. #z                       "#z" terminates the current script.
  253.  
  254.  
  255.  
  256.  
  257. 6.0  FILE TRANSFER
  258.  
  259. AmigaHost supports a variety of file transfer protocols:
  260.  
  261.  
  262.  
  263. 6.1  
  264.  
  265. CompuServe B Protocol
  266.  
  267. B protocol is an error  correcting  file  transfer  protocol
  268. developed  by  CompuServe  Inc.   to  facilitate transfer of
  269. data, programs, text files etc.
  270.  
  271. Select "B Protocol" when uploading or downloading files from
  272. CompuServe.   There are no menu options for B protocol.  The
  273. CompuServe's software will cause the Amiga  to  perform  the
  274. upload/download.
  275.  
  276. If you select file type ASCII (in response to  a  CompuServe
  277. prompt)    the    Amiga    translates   all   linefeeds   to
  278. carriage-return/linefeed for files  that  are  uploaded  (to
  279. CompuServe),  and  strips all carriage-returns on downloads.
  280. Binary files are transfered "as is".
  281.                                                       Page 6
  282.  
  283.  
  284. 6.2  
  285.  
  286. XMODEM
  287.  
  288. XMODEM is a simple protocol developed to allow file transfer
  289. between two (CP/M) micro computers.
  290.  
  291. To upload/download files with AmigaHost using XMODEM, log in
  292. to  the  remote  computer and initiate a send/receive there,
  293. then select "Send" or "Receive" from the  "XMODEM"  menu  as
  294. appropriate.
  295.  
  296. You must select either "ASCII" or  "Binary"  as  a  sub-item
  297. when performing XMODEM file transfers.
  298.  
  299. When uploading  ASCII  files  linefeeds  are  translated  to
  300. carriage-return/linefeed.    When  downloading  ASCII  files
  301. carriage-returns are striped.  Binary files  are  transfered
  302. "as is".
  303.  
  304. AmigaHost's XMODEM does not support CRC.
  305.  
  306.  
  307.  
  308. 6.3  
  309.  
  310. Kermit
  311.                 === Section Not Complete ===
  312.  
  313.  
  314.  
  315. 6.4  
  316.  
  317. Capture/Send
  318.  
  319. You may "Capture" text to a file as it comes in  the  serial
  320. line.   To  capture  text,  choose  "Open Log File" from the
  321. "File" menu.  A requester will appear to allow you  to  type
  322. the  name of a file in which to save all incomming text.  To
  323. stop capturing text,  choose  "Close  Log  File"  (from  the
  324. "File" menu).
  325.  
  326. To send a text file "verbatim" to a remote computer,  select
  327. "Send Text File" from the "File" menu.
  328.  
  329.  
  330.  
  331. 7.0  RLE GRAPHICS
  332.  
  333. AmigaHost supports CompuServe's RLE graphics protocol.  Type
  334. "GO VID100" at any "!" prompt for selection of RLE pictures.
  335.                                                       Page 7
  336.  
  337.  
  338. 8.0  CONFERENCE MODE
  339.  
  340. AmigaHost supports a  special  mode  to  facilitate  use  of
  341. CompuServe's Conferencing/CB environment.
  342.  
  343. The user types his input in one window, and  all  output  is
  344. routed to a second window.
  345.  
  346. The  user  may  request  highlighting  of  lines  containing
  347. specific patterns (such as a person's CB handle, or words of
  348. interest   like   "disk"   or   "monitor").    To    request
  349. highlighting,  choose "Set Pattern" and a highlighting color
  350. from the "CO-Options" menu.  A  requester  will  pop  up  to
  351. allow  you  to  enter  the  pattern  to be highlighted.  All
  352. subsequent output  lines  containing  the  pattern  will  be
  353. displayed in the color selected.
  354.  
  355. Text  Capture  (logging)  may  be  turned  off  and  on   in
  356. conference  mode  by  selecting  "Open  Logfile"  or  "Close
  357. Logfile" from the CO-Options menu.
  358.  
  359.  
  360.  
  361. 9.0  CAVIAT EMPTOR
  362.  
  363. AmigaHost always sends 8 bit, no  parity  data,  and  strips
  364. parity on data received.  XON/XOFF is not enabled.
  365.  
  366. System requestors  appear  on  the  workbench  screen.   For
  367. example, if a file can not be opened because a disk is write
  368. protected, the message concerning the write protection  will
  369. come  up  behind  the  AmigaHost  screen, both file transfer
  370. windows will be deactivated.  To  see  the  requester,  type
  371. Left-Amiga-N, to get back to AmigaHost, type Left-Amiga-M.
  372.